Gets a list of user and group entries from the local file server.

OSErr PBGetUGEntrySync (
    HParmBlkPtr paramBlock
);

Parameter descriptions

paramBlock

A pointer to an objParam variant of an HFS parameter block.

function result

A result code.

DISCUSSION

The relevant fields of the parameter block are:

• ioCompletion

  On input, a pointer to a completion function.

• ioResult

  On output, the result code of the function.

• ioObjType

  On input, a function code. You specify whether you want information about users or groups by setting this field to the desired value. Set ioObjType to 0 to receive the next user entry; set it to –1 to receive the next group entry.

• ioObjNamePtr

  On return, a pointer to the returned user/group name. The user or group name is returned as a Pascal string. The maximum size of the string is 31 characters, preceded by a length byte. If you set ioObjNamePtr to NULL, no name is returned.

• ioObjID

  A user/group ID. If you set ioObjID to 0, PBGetUGEntrySync returns information about the user or group known to the local server whose name is alphabetically first. If the value of ioObjID is not 0, PBGetUGEntrySync returns information about the user or group whose name follows immediately in alphabetical order that of the user or group having that ID.

The PBGetUGEntrySync function returns the name and ID of the user or group whose name is alphabetically next to that of the user or group whose ID is contained in the ioObjID field. You can enumerate the users or groups in alphabetical order by setting ioObjID to 0 and then repetitively calling PBGetUGEntrySync with the same parameter block until the result code fnfErr is returned.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.

© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)